Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
eslint-plugin-n
Advanced tools
forked from eslint-plugin-node v11.1.0. as the original repository seems no longer maintained.
Additional ESLint's rules for Node.js
npm install --save-dev eslint eslint-plugin-n
>=12.22.0
>=7.0.0
Note: It recommends a use of the "engines" field of package.json. The "engines" field is used by n/no-unsupported-features/*
rules.
.eslintrc.json (An example)
{
"extends": ["eslint:recommended", "plugin:n/recommended"],
"parserOptions": {
// Only ESLint 6.2.0 and later support ES2020.
"ecmaVersion": 2020
},
"rules": {
"n/exports-style": ["error", "module.exports"],
"n/file-extension-in-import": ["error", "always"],
"n/prefer-global/buffer": ["error", "always"],
"n/prefer-global/console": ["error", "always"],
"n/prefer-global/process": ["error", "always"],
"n/prefer-global/url-search-params": ["error", "always"],
"n/prefer-global/url": ["error", "always"],
"n/prefer-promises/dns": "error",
"n/prefer-promises/fs": "error"
}
}
package.json (An example)
{
"name": "your-module",
"version": "1.0.0",
"type": "commonjs",
"engines": {
"node": ">=8.10.0"
}
}
💼 Configurations enabled in.
✅ Set in the recommended
configuration.
🔧 Automatically fixable by the --fix
CLI option.
❌ Deprecated.
Name | Description | 💼 | 🔧 | ❌ |
---|---|---|---|---|
no-deprecated-api | disallow deprecated APIs | ✅ |
Name | Description | 💼 | 🔧 | ❌ |
---|---|---|---|---|
handle-callback-err | require error handling in callbacks | |||
no-callback-literal | enforce Node.js-style error-first callback pattern is followed | |||
no-exports-assign | disallow the assignment to exports | ✅ | ||
no-extraneous-import | disallow import declarations which import extraneous modules | ✅ | ||
no-extraneous-require | disallow require() expressions which import extraneous modules | ✅ | ||
no-hide-core-modules | disallow third-party modules which are hiding core modules | ❌ | ||
no-missing-import | disallow import declarations which import non-existence modules | ✅ | ||
no-missing-require | disallow require() expressions which import non-existence modules | ✅ | ||
no-new-require | disallow new operators with calls to require | |||
no-path-concat | disallow string concatenation with __dirname and __filename | |||
no-process-exit | disallow the use of process.exit() | ✅ | ||
no-unpublished-bin | disallow bin files that npm ignores | ✅ | ||
no-unpublished-import | disallow import declarations which import private modules | ✅ | ||
no-unpublished-require | disallow require() expressions which import private modules | ✅ | ||
no-unsupported-features | disallow unsupported ECMAScript features on the specified version | ❌ | ||
no-unsupported-features/es-builtins | disallow unsupported ECMAScript built-ins on the specified version | ✅ | ||
no-unsupported-features/es-syntax | disallow unsupported ECMAScript syntax on the specified version | ✅ | ||
no-unsupported-features/node-builtins | disallow unsupported Node.js built-in APIs on the specified version | ✅ | ||
process-exit-as-throw | require that process.exit() expressions use the same code path as throw | ✅ | ||
shebang | require correct usage of shebang | ✅ | 🔧 |
Name | Description | 💼 | 🔧 | ❌ |
---|---|---|---|---|
callback-return | require return statements after callbacks | |||
exports-style | enforce either module.exports or exports | 🔧 | ||
file-extension-in-import | enforce the style of file extensions in import declarations | 🔧 | ||
global-require | require require() calls to be placed at top-level module scope | |||
no-mixed-requires | disallow require calls to be mixed with regular variable declarations | |||
no-process-env | disallow the use of process.env | |||
no-restricted-import | disallow specified modules when loaded by import declarations | |||
no-restricted-require | disallow specified modules when loaded by require | |||
no-sync | disallow synchronous methods | |||
prefer-global/buffer | enforce either Buffer or require("buffer").Buffer | |||
prefer-global/console | enforce either console or require("console") | |||
prefer-global/process | enforce either process or require("process") | |||
prefer-global/text-decoder | enforce either TextDecoder or require("util").TextDecoder | |||
prefer-global/text-encoder | enforce either TextEncoder or require("util").TextEncoder | |||
prefer-global/url | enforce either URL or require("url").URL | |||
prefer-global/url-search-params | enforce either URLSearchParams or require("url").URLSearchParams | |||
prefer-promises/dns | enforce require("dns").promises | |||
prefer-promises/fs | enforce require("fs").promises |
This plugin provides three configs:
Name | Description |
---|---|
plugin:n/recommended | Considers both CommonJS and ES Modules. If "type":"module" field existed in package.json then it considers files as ES Modules. Otherwise it considers files as CommonJS. In addition, it considers *.mjs files as ES Modules and *.cjs files as CommonJS. |
plugin:n/recommended-module | Considers all files as ES Modules. |
plugin:n/recommended-script | Considers all files as CommonJS. |
These preset configs:
process.exit()
.{ecmaVersion: 2019}
and etc into parserOptions
.globals
.plugins
.no-missing-import
/ no-missing-require
rules don't work with nested folders in SublimeLinter-eslinteslint-plugin-n
follows semantic versioning and ESLint's Semantic Versioning Policy.
Deprecated rules follow ESLint's deprecation policy.
Welcome contributing!
Please use GitHub's Issues/PRs.
npm test
runs tests and measures coverage.npm run coverage
shows the coverage result of npm test
command.npm run clean
removes the coverage result of npm test
command.FAQs
Additional ESLint's rules for Node.js
The npm package eslint-plugin-n receives a total of 2,300,684 weekly downloads. As such, eslint-plugin-n popularity was classified as popular.
We found that eslint-plugin-n demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.